Android Demo

一、下载

1.1. demo应用

下载地址 版本号 发布时间 更新说明
demo_apk v6.2.7.13 2019.04.03 1.调整demo界面，更新大部分界面及重构部分功能，使demo更加方便易用 2.新增保存已使用过的产品ID及企业信息，方便重复使用 3.新增SDK相应功能测试
demo_apk v6.2.3.12 2018.09.20 1.新增smarklink配网功能 2.同步更新 XAPP SDK 版本到6.2.3.7 3.更新部分配置功能
demo_apk v6.2.0.4 2018.07.03 1.同步更新 XAPP SDK 版本到6.1.0.3 2.修复离线时设备无法分享的问题 3.更新测试环境API 4.调整XLinkDataPoint的引用（新版本变更内容）
demo_apk v6.1.0.12 2018.05.24 1.同步更新 XAPP SDK 版本到6.0.7.1
demo_apk v6.1.0.8 2018.05.18 1.新增API环境切换设置,切换环境不再需要重新编译 2.新增二维码扫描订阅设备功能 3.新增home相关功能 4.更新优化demo部分UI显示与实现逻辑

1.2. 项目源码

下载地址 版本号 发布时间 更新说明
demo_source v6.2.7.13 2019.04.03 见同步更新的demo_apk
demo_source v6.2.3.12 2018.09.20 见同步更新的demo_apk
demo_source v6.2.0.4 2018.07.03 见同步更新的demo_apk
demo_source v6.1.0.8 2018.05.18 见同步更新的demo_apk

1.2.1. 项目源码编译环境

  • 自v6.2.7.x版本起，编译环境更新为
编译环境 说明
AS版本 3.3.2
gradle版本 3.3.2
其它 升级到AndroidX
  • 旧版本编译环境
编译环境 说明
AS版本 3.0.1
gradle版本 4.1

请注意关于DEMO的一些事项:

  • 该APK为调试版本APK
  • demo默认为正式环境的API,若需要使用其它环境请在demo中切换
  • 不同环境(如正式环境/测试环境)的账号无法互通,请注意
  • 若安装后无法进入主界面,请确认是否开启存储权限及相机权限(v6.2版本DEMO后已进行权限申请处理)

二、说明文档

2.1. 概述

SDK_DEMO 是基于 XAPP SDK 实现的便于测试和验证的 DEMO 程序。其包含以下功能（自v6.2.7.13版本起）：

  1. 用户登录
  2. 动态的 XAPP SDK 配置
  3. XAPP SDK 的使用（包括设备扫描、添加订阅、移除、控制、状态获取、设备连接等）
  4. Home 相关操作（暂不包括 Room 操作）
  5. 第三方推送快捷配置（包括 FCM 与阿里云）
  6. 汉枫配网功能（集成自汉枫，与 XAPP SDK 本身无关联）
  7. 二维码订阅设备、SN 订阅设备
  8. 基础的 DEMO 信息（使用的 XAPP SDK 版本、当前登录的用户信息、DEMO 运行的日志信息、第三方推送消息的缓存记录）

2.2. 使用说明

所有功能都有自身的作用或目的，部分功能由于程序显示问题或描述问题无法在程序中以详细的提示文本说明清楚功能的作用，在这里指出部分功能的作用或如何使用。

2.2.1. 动态配置 XAPP SDK

DEMO 支持在启动程序时可以动态修改 XAPP SDK 配置或重新初始化；这一步是非常重要的。强烈建议参考开发指南中所有的配置项，这样会更加清楚该配置项的作用与目的。
以下仅列出部分重要的配置项及功能。

2.2.1.1. 私有云环境配置
  1. 选择【自定义环境】
  2. 输入【API 地址及端口号】；输入【CM 地址及端口号】；若不清楚使用的环境信息请咨询项目经理、对接人员或提交售后服务。
  3. 若私有云环境有自签 SSL 证书，请选择【使用 SSL 证书】并选择证书文件，否则可能无法正确连接到相关服务器；（注意证书将用到 API 及 CM 服务器连接中）
  4. 切换【CM 客户端版本号】，由于支持的设备版本及 XAPP SDK 版本更新，公有云环境默认支持版本3；若私有云环境未使用新的设备版本或更新到最新服务版本，请切换到版本2；
2.2.1.2. 内网自动连接（自 XAPP SDK v6.2.6.x 版本起）
  1. 若设备不需要内网连接或通讯，仅通过云端操作，可以不勾选【内网自动连接】功能；以降低 XAPP SDK 资源占用及数据维护成本；不勾选内网自动连接的情况下，设备将会内网不在线。
2.2.1.3. 协议版本支持（自 XAPP SDK v6.2.6.x 版本起）
  1. XAPP SDK 是同时兼容所有版本的 XMQTT 协议，包括了v5/v6版本的协议
  2. 使用哪个类型的协议是取决于设备使用的协议版本，若设备使用了v5版本协议，则 XAPP SDK 需要使用v5协议版本；若设备使用了v6版本协议，则 XAPP SDK 需要使用v6版本协议；
  3. 使用v6.x版本的设备，XAPP SDK 都需要使用v6版本的协议
  4. 使用v6.2版本的设备，XAPP SDK 的【CM 客户端版本号】需要使用版本3
2.2.1.4. 登录源

登录源是用于标识当前用户的来源信息；如在 APP 中登录，可以将登录源设置为“APP”；在 TV 中登录，可以将登录源设置为“TV”；

  1. 登录源允许为空
  2. 登录源仅支持数字及26个字母，不能使用空格及特殊符号；最大长度为16个字符
  3. 相同登录源（登录源字符完全匹配）的用户会互相强制下线，即同一时间仅允许同一登录源的用户存在；不同登录源的用户不受影响
2.2.1.5. 初始化及快捷登录
  1. 当进行了任何的 XAPP SDK 配置修改后，需要生效则必须进行重新初始化；
  2. 使用上一次的配置信息及用户信息直接快捷登录时，则不需要修改配置直接【快捷登录】即可；

2.2.2. DEMO 功能

配置功能是主要的对设备相关的操作，或者是 DEMO 中最常用的操作；在登录成功后进入程序主界面后下方的【配置】tab 即可。

2.2.2.1. 设备配网

设备配网功能目前集成自【汉枫】的 smartlink 配网功能，根据【汉枫】提供的 DEMO 修改引入程序中，方便对设备进行配网操作。

  1. 仅用于【汉枫】模块的 smartlink 配网，不能用于其它模块的配网；
  2. 配网功能来自于【汉枫】提供的功能，与 XAPP SDK 本身功能无任何关联，若配网中存在疑问请咨询【汉枫】的技术支持人员；
  3. 建议自行开发 APP 时，重新集成配网功能，不要复用此 DEMO 中的配网功能；
2.2.2.2. 二维码订阅设备

需要二维码订阅设备时，请使用扫描二维码功能扫描设备二维码订阅。二维码订阅设备前，请务必确保设备已设置允许二维码订阅并且设备已上报二维码订阅相关的数据端点。

2.2.2.3. SN码订阅

SN 码订阅设备时需要提供设备的 SN 码，请确保设备允许二维码订阅并且设备存在 SN 码；设备至少需要已激活后才能进行订阅。

2.2.2.4. 第三方推送配置

第三方推送配置允许将应用与第三方推送关联，从而实现将消息推送转发到第三方推送，实现消息的离线推送与接收。

  1. 目前支持的第三方推送配置支持：FCM 配置、阿里推送
  2. 推送配置方式请参考开发指南相关文档
2.2.2.5. 辅助功能
  1. 【修改产品ID】不属于 XAPP SDK 本身的功能，仅 DEMO 程序为了方便频繁切换产品ID提供的功能
  2. 【日志信息】不属于 XAPP SDK 本身的功能，仅 DEMO 程序为了方便查看当前运行时保存的日志信息及管理日志文件夹下的日志文件列表提供的功能
  3. 【推送消息记录】不属于 XAPP SDK 本身的功能，仅 DEMO 程序为了方便提供查看第三方推送消息的记录功能，所有消息仅缓存在内存中并且离线后不会记录消息
  4. 【显示SDK版本】、【显示用户信息】均为方便显示当前 DEMO 使用的信息

三、更新说明

日期 更新内容
2019-04-03 更新v6.2.7.13版本demo及源码；更新demo使用说明介绍
没找到需要的文档？
你可以提交工单反馈 或 阅读常见问题
客服工单常见问题